Créer un notebook avec Quarto: principes, fonctionnalités

SAGEO, 2023 - Québec, Canada

Nicolas Lambert, Timothée Giraud, Matthieu Viry, Ronan Ysebaert

07 Jun 2023

Evolution des pratiques

Avant ( > ~ 2011) : des “black-boxes” méthodologiques

Logiciels payants, ruptures logicielles dans les chaines de traitements, stockage et partage des données et méthodes non optimisé, univers “clic-bouton”.

Evolution des pratiques

Ensuite ( 2011 > récemment)

Solutions open source, gratuites, qui couvrent l’ensemble de la chaîne de traitement de l’information, univers de programmation.


Evolution des pratiques

Depuis peu

Mise à jour de ce graphique en intégrant les dimensions Python, Js > plus forcément chaînes de traitement.

Evolution des pratiques

Pb (1) : Comment passer d’un langage à l’autre ?

  • Préparation et manipulation des données dans des langages performants (R, Python…)
  • Visualisation et interactivité dans le navigateur (JS)

Pb (2) : Comment documenter et partager ses traitements ?

  • Création de bcp de scripts.
  • Compréhensible par soi (et encore, avec le temps)…
  • Transmettre, mettre à jour…

Recherche reproductible

Ouverture des protocoles de recherche dans l’objectif de confirmer et rendre répétable des résultats de recherche.

  • Disponibilité des données et du code, exécutable.
  • Documentation de l’environnement logiciel nécessaire à son exécution.
  • Transparence dans la collecte de données, ses traitements, analyses et sorties graphiques.
  • Réutilisable par d’autres : documentation du code, de ce qu’il produit et dans quel but.
  • Ouvert aux retours, commentaires, suggestions, critiques, révisions.

Jon Claerbout (sismologue, Univ. Stanford). Il utilise avec son groupe pour la première fois le terme de “recherche reproductible” lors du congrès de la Society of Exploration Geophysics en 1992.

Programmation lettrée & notebooks

Paradigme de programmation (Knuth, 1984) qui consiste à associer code source (pour les ordinateurs) et documentation (pour les humains).

  • Donner les informations suffisantes pour répliquer l’expérimentation, à la manière d’un essai.
  • Vérifier que les conclusions sont valides.
  • Améliorer les programmes / rendre les mauvaises décisions de conception plus évidentes.
  • Utile pour reprendre les programmes ultérieurement.
  • Transmettre et partager les connaissances sous des formes appropriées (tutoriels, manuels).

Donald Knuth (mathématicien, Univ. Stanford). Pose les bases de la programmation lettrée dans un premier environnement de literate programming : le WEB qui combine du Pascal et du TeX, appliqué aux nombres premiers (1984).

Un gain général en reproductibilité de la démarche et en ouverture des méthodes scientifiques.

Notebooks : Principes fondamentaux

Le Notebook est une solution opérationnelle et adaptée pour arriver à ces fins.

Source: Pecout, 2022

Les notebooks du moment

Source : Pecout, 2022

Quarto ?

  • Moins dépendant de R (pas d’installation de packages R, comme c’était le cas avec RMarkdown) > peut fonctionner ailleurs que dans l’IDE RStudio (pas d’utilisation de knitr).
  • Possibilité de mises en page customisées (templates ++)
  • OJS > doc interactifs

Des sorties multiples

Squelette d’un notebook (RMarkdown / Quarto)

Source : Pecout, 2022

Initier un document Quarto dans RStudio

RStudio propose plusieurs modèles pour initier aisément un notebook.

Initier un document Quarto dans RStudio

RStudio propose plusieurs modèles pour initier aisément un notebook.

Paramétrer son document grâce au YAML

Le YAML permet de définir :

  • Le format de sortie désiré (HTML, PDF, .doc, etc.)

  • Le type de document souhaité (Document, présentation, site Web, etc.)

Il est hautement paramétrable :

  • des paramétrages généraux (choisir un thème, définir une feuille de style css)
  • la table des matières (toc)
  • la numérotation des parties du document
  • les typographies utilisées
  • le choix des couleurs
  • l’affichage des blocs de code
  • l’exécution du code (afficher le code ou non, des messages d’erreur, etc.)
  • le dimensionnement des figures et tables
  • la gestion des urls
  • le paramétrage de la bibliographie
  • l’affichage des notes de bas de page
  • les métadonnées associées au document…

Les possibilités offertes sont présentées dans la documentation Quarto

Paramétrer son document grâce au YAML

Le YAML utilisé pour cette présentation

---
title: "Créer un notebook avec Quarto: principes, fonctionnalités"
subtitle: "SAGEO, 2023 - Québec, Canada"
author: "Nicolas Lambert, Timothée Giraud,  Matthieu Viry, Ronan Ysebaert"
date: 06/7/2023
date-format: "DD MMM YYYY"
title-slide-attributes:
  data-background-color: black
  data-background-image: fig/SAGEO.png
  data-background-size: cover
  data-background-opacity: "0.5"
format:
  revealjs:
    margin: 0
    embed-resources: true
    smaller: true
    scrollable: true
    theme: [simple, custom.scss]
    code-line-numbers: false
editor: visual
execute:
  echo: true
---

Décrire simplement son cheminement grâce à au markdown

  • Langage de balisage léger

  • h1, h2, h3 bold, italic import figure

  • Callout blocks

Paramétrer ses blocs de code grâce aux chunks

  • possibilité d’intégrer du code Python, R, Julia, Observable JS au sein du même document.

  • echo, eval, warning, message, cache, fig.height

  • possibilité de le spécifier dans le YAML (execute:)…

  • ou directement dans les chunks

A vous de jouer !

[To do] : Initier un document Quarto

  • Créer un modèle Quarto avec RStudio
  • Jouer avec les métadonnées pour paramétrer le document (nom de l’auteur, ajout table des matières, etc.)